Skip to content

Include primary cache keys as restore key - #4206

Open
mbg wants to merge 2 commits into
mainfrom
mbg/set-restore-keys
Open

mbg wants to merge 2 commits into
mainfrom
mbg/set-restore-keys

Conversation

@mbg

@mbg mbg commented Oct 7, 2026

Copy link
Copy Markdown
Member

See #4202 for context. Apparently some third-party systems don't use the primary cache key that's used for cache restores as a restore key if it's not also included separately as a restore key. This PR changes our restoreCache calls so that the primary restore key is also always included as a restore key. This should not make a difference on first-party systems.

Risk assessment

For internal use only. Please select the risk level of this change:

  • Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only.

Which use cases does this change impact?

Workflow types:

  • Advanced setup - Impacts users who have custom CodeQL workflows.
  • Managed - Impacts users with dynamic workflows (Default Setup, Code Quality, ...).

Products:

  • Code Scanning - The changes impact analyses when analysis-kinds: code-scanning.
  • Code Quality - The changes impact analyses when analysis-kinds: code-quality.
  • Other first-party - The changes impact other first-party analyses.

Environments:

Third-party runner environments.

  • Dotcom - Impacts CodeQL workflows on github.com and/or GitHub Enterprise Cloud with Data Residency.
  • GHES - Impacts CodeQL workflows on GitHub Enterprise Server.

How did/will you validate this change?

  • Unit tests - I am depending on unit test coverage (i.e. tests in .test.ts files).
  • End-to-end tests - I am depending on PR checks (i.e. tests in pr-checks).

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

  • Rollback - Change can only be disabled by rolling back the release or releasing a new version with a fix.

How will you know if something goes wrong after this change is released?

  • Telemetry - I rely on existing telemetry or have made changes to the telemetry.
    • Dashboards - I will watch relevant dashboards for issues after the release. Consider whether this requires this change to be released at a particular time rather than as part of a regular release.

Are there any special considerations for merging or releasing this change?

  • No special considerations - This change can be merged at any time.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Consider adding a changelog entry for this change.
  • Confirm the readme and docs have been updated if necessary.

@github-actions github-actions Bot added the size/XS Should be very easy to review label Oct 7, 2026
@mbg
mbg marked this pull request as ready for review October 12, 2026 15:26
@mbg
mbg requested a review from a team as a code owner October 12, 2026 15:26
Copilot AI balanced review requested due to automatic review settings October 12, 2026 15:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning

  • Copilot's review of this pull request may be incomplete because some of the changed files are excluded by your Copilot content exclusion settings. See Excluding content from Copilot for details.

🟡 Changes recommended

The backend-compatibility behavior lacks regression assertions in the existing unit tests.

4 open findings
What changed in this PR

Adds primary cache keys to restore-key lists for compatibility with third-party cache backends that only prefix-match restore keys.

Changes:

  • Updates dependency, TRAP, and overlay cache restoration.
  • Applies the behavior consistently across source call sites.
File Description
src/​trap-caching.ts Adds the preferred key to restore keys.
src/​dependency-caching.ts Adds the primary dependency key to restore keys.
src/​overlay/​status.ts Adds the status key to restore keys.
src/​overlay/​caching.ts Fixes overlay-base restoration on affected backends.
lib/​entry-points.js Excluded generated file; not reviewed.
Files excluded by content exclusion policy (1)
  • lib/entry-points.js

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/dependency-caching.ts

const primaryKey = await cacheKey(codeql, features, language, patterns);
const restoreKeys: string[] = [
primaryKey,
Comment thread src/overlay/caching.ts
[dbLocation],
cacheRestoreKeyPrefix,
undefined,
[cacheRestoreKeyPrefix],
Comment thread src/overlay/status.ts
const foundKey = await waitForResultWithTimeLimit(
MAX_CACHE_OPERATION_MS,
actionsCache.restoreCache([statusFile], cacheKey),
actionsCache.restoreCache([statusFile], cacheKey, [cacheKey]),
Comment thread src/trap-caching.ts
const found = await waitForResultWithTimeLimit(
MAX_CACHE_OPERATION_MS,
actionsCache.restoreCache([cacheDir], preferredKey, [
preferredKey,

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS Should be very easy to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants